<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class LinkedCacheSet</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class LinkedCacheSet</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Quasi-equivalent (superior in some repects) to Java's LinkedHashSet.  Uses memcached as a storage  mechanism for persisting set data beyond the scope of the current request.</p>
		<p class="notes">
			Located in <a class="field" href="_php---client---LinkedCacheSet.php.html">/php/client/LinkedCacheSet.php</a> (line <span class="field"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a37">37</a></span>)
		</p>
		
				
		<pre><a href="../Disperse/CacheSet.html">CacheSet</a>
   |
   --LinkedCacheSet</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																				
												<div class="method-definition">
											<span class="method-result">LinkedCacheSet</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__destruct" title="details" class="method-name">__destruct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#add" title="details" class="method-name">add</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#current" title="details" class="method-name">current</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#delete" title="details" class="method-name">delete</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#first" title="details" class="method-name">first</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#last" title="details" class="method-name">last</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#move" title="details" class="method-name">move</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$delta</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$forward</span> = <span class="var-default">true</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#next" title="details" class="method-name">next</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#previous" title="details" class="method-name">previous</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#seek" title="details" class="method-name">seek</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set" title="details" class="method-name">set</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../Disperse/CacheSet.html">CacheSet</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Disperse/CacheSet.html#var$cache">CacheSet::$cache</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Disperse/CacheSet.html#var$name">CacheSet::$name</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../Disperse/CacheSet.html#var$set">CacheSet::$set</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a44">44</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class constructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">LinkedCacheSet</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheSet.html#method__construct">CacheSet::__construct()</a></dt>
						<dd>Class constructor</dd>
					</dl>
			
	</div>
<a name="method__destruct" id="__destruct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a52">52</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class destructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__destruct
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheSet.html#method__destruct">CacheSet::__destruct()</a></dt>
						<dd>Class destructor</dd>
					</dl>
			
	</div>
<a name="methodadd" id="add"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">add</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a61">61</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds the specified element to the end of the set.  The internal pointer is updated to the  position of the element (last in the set).</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			add
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$key</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheSet.html#methodadd">CacheSet::add()</a></dt>
						<dd>Adds the specified element to the end of the set.</dd>
					</dl>
			
	</div>
<a name="methodcurrent" id="current"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">current</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a72">72</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the element referenced by the internal pointer, or null if there is no element at the  current position.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			current
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">delete</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a83">83</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Deletes and returns the specified element from the set, or returns null if the element does not  exist.  The internal pointer is updated to the first element in the set.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			delete
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$key</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheSet.html#methoddelete">CacheSet::delete()</a></dt>
						<dd>Deletes and returns the specified element from the set, or null if the element does not exist.</dd>
					</dl>
			
	</div>
<a name="methodfirst" id="first"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">first</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a95">95</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Updates the internal pointer to the first element in the set and returns that element, or false  if the set is empty.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			first
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlast" id="last"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">last</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a105">105</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Updates the internal pointer to the last element in the set and returns that element, or false  if the set is empty.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			last
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodmove" id="move"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">move</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a119">119</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Moves the internal pointer by a magnitude of $delta.  The default is to move the pointer in a  forward direction.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			move
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$delta</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$forward</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$delta</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$forward</span><span class="var-description">: = true</span>			</li>
				</ul>
		
			
	</div>
<a name="methodnext" id="next"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">next</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a131">131</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Updates the internal pointer to the next element in the set and returns that element, or false  if there is no element at that location.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			next
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodprevious" id="previous"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">previous</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a141">141</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Updates the internal pointer to the previous element in the set and returns that element, or  false if there is no element at that location.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			previous
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodseek" id="seek"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">seek</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a152">152</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Updates the internal pointer to the specified element in the set and returns that element, or  returns false if key does not exist.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			seek
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$key</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset" id="set"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set</span> (line <span class="line-number"><a href="../__filesource/fsource_Disperse__phpclientLinkedCacheSet.php.html#a174">174</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Updates the specified element's value within the set.  The internal pointer is updated to the  position of the element.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$key</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Disperse/CacheSet.html#methodset">CacheSet::set()</a></dt>
						<dd>Updates the specified element's value within the set.</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Disperse/CacheSet.html">CacheSet</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Disperse/CacheSet.html#method__construct">CacheSet::__construct()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodadd">CacheSet::add()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodcontains">CacheSet::contains()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodcopy">CacheSet::copy()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methoddelete">CacheSet::delete()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodget">CacheSet::get()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodindexOf">CacheSet::indexOf()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodisEmpty">CacheSet::isEmpty()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodload">CacheSet::load()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodpurge">CacheSet::purge()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodsave">CacheSet::save()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodset">CacheSet::set()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodsize">CacheSet::size()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodsort">CacheSet::sort()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodsortByKey">CacheSet::sortByKey()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodupdate">CacheSet::update()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#methodvalueOf">CacheSet::valueOf()</a></span><br>
													<span class="method-name"><a href="../Disperse/CacheSet.html#method__destruct">CacheSet::__destruct()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 06 Mar 2010 15:50:40 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>